home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Commodities / CapShift / Doc / English / CapShift.doc < prev    next >
Encoding:
Text File  |  1996-09-27  |  10.0 KB  |  227 lines
  1. $VER: CapShift.doc 1.00 (19.8.93) © Alessandro Sala
  2.  
  3.                     CapShift version 1.00 19-Aug-1993
  4.                    Copyright © 1993 By Alessandro Sala
  5.  
  6.              Requires AmigaOS v2.04 ( Kickstart v37 ) or later
  7.  
  8.  
  9.                                ------------
  10.                                 Disclaimer
  11.                                ------------
  12.  
  13.    This program is provided "as is" without warranty of any kind, either
  14. expressed or implied, including, but not limited to, the implied warranty
  15. of fitness for a particular purpose.  Though every care has been taken to
  16. make this program system-friendly and bugs-free, the entire risk as to the
  17. results, reliability and performance of this program is assumed by you.
  18.  
  19.  
  20.                             ------------------
  21.                              Copyright notice
  22.                             ------------------
  23.  
  24.    This program is "FreeWare": it can be freely copied and distributed for
  25. non-commercial purposes, provided that no file is added to or removed from the
  26. distribution archive and no charge, beside a nominal fee, is requested.
  27.    Nevertheless the program remains COPYRIGHT of the Author: you cannot
  28. patch, reverse engineer or otherwise modify the program, the documentation and
  29. every other file found in the distribution archive except where explicitly
  30. allowed.
  31.    Compressing in executable form is allowed for personal use but not
  32. for distribution: LHARC'ing in an archival form is explicitly allowed for
  33. distribution convenience.
  34.    Furthermore you cannot embed the program in any other software without
  35. the written permission of the author.
  36.  
  37.                      ------------------------------------
  38.                      Contents of the distribution archive
  39.                      ------------------------------------
  40.  
  41.     CapShift             : The main program
  42.     CapShift.info        : Related '.info' file with pre-set tooltypes
  43.  
  44.     Doc
  45.       Italiano.leggimi   : General information in italian language
  46.       Italiano
  47.         Italiano.doc     : Italian documentation in ASCII format
  48.         Italiano.guide   : Italian documentation in AmigaGuide format
  49.  
  50.       English.readme     : General information in english language
  51.       English
  52.         English.doc      : English documentation in ASCII format
  53.         English.guide    : English documentation in AmigaGuide format
  54.  
  55.     Install
  56.       Italiano           : Italian installation script (see Italiano.leggimi)
  57.       English            : English installation script (see English.readme)
  58.  
  59.     Catalogs
  60.       CapShift.ct        : Empty translation file
  61.       italiano
  62.         CapShift.catalog : Italian language support file
  63.  
  64.     Various '.info' files
  65.  
  66.                                ---------------
  67.                                1. Introduction
  68.                                ---------------
  69.  
  70.  
  71.                               What is CapShift ?
  72.                               ------------------
  73.  
  74.    CapShift is a simple commodity and its main function is to modify the
  75. behaviour of the 'shift' key: if you press 'shift' when the capslock key is on,
  76. normally nothing happens; with CapShift the capslock state AND the shift state
  77. are turned off until you release the 'shift' key, which is now acting as a
  78. 'capital-toggle' if you press an alphabetic key (A...Z) :
  79.  
  80.            capslock | shift | result
  81.            ---------+-------+---------
  82.               off   |  off  | lowercase
  83.               off   |  on   | uppercase
  84.               on    |  off  | uppercase
  85.               on    |  on   | lowercase
  86.  
  87.    CapShift has also another feature you can turn on: the so-called
  88. 'capslock killing'. The capslock key is rarely used as a qualifier for the
  89. 'highmap' keys (f1-f10, esc, return, enter, tab, backspace, del, help, cursor
  90. keys), nevertheless it IS a qualifier and, if it is on, some key combinations
  91. (especially hotkeys) don't work as expected. With hotkeys, you can avoid this
  92. problem if you put '-capslock' in every hotkey description, when this is
  93. possible,  but this can be annoying. Besides, if the problem isn't with a hotkey
  94. there is often no solution. Here comes CapShift: you can choose to turn off the
  95. capslock qualifier when one of the 'highmap' keys is pressed: simply add the
  96. 'KILLHIGHCAPS' tooltype to the CapShift's icon, or use the same argument from
  97. CLI. You can also turn on 'capslock killing' when one ore more of the 'control',
  98. 'alt' or 'amiga' qualifier is pressed and with the keypad's keys: simply add
  99. the 'KILLQUALCAPS' tooltype to the CapShift's icon, or use the same argument
  100. from CLI.
  101.  
  102.  
  103.                                 Installation
  104.                                 ------------
  105.  
  106.    To install CapShift, if you have the 'Installer' utility from Commodore (see
  107. English.readme), you can simply double-click the 'English' icon found in the
  108. 'Install' drawer.
  109.    Differently, you can simply copy CapShift in some drawer, typically
  110. your SYS:WBStartup drawer. If you have OS 2.1 or later and you want to
  111. take advantage of localization, you must also copy the 'catalogs' drawer, found
  112. in the CapShift distribution archive, into the same drawer as CapShift, or
  113. you can copy the 'CapShift.catalog' file ( found in the 'catalogs/<language>/'
  114. drawer ) into your 'LOCALE:catalogs/<language>/' drawer.
  115.    If your language is not currently available, you can fill in the empty
  116. translation file found in the catalogs drawer ( catalogs/CapShift.ct ) and
  117. send it to me by E-Mail ( the address is at the end of this file ). I will
  118. create a new '<your-language>/CapShift.catalog' file and E-Mail it to you as
  119. soon as possible, and the next version of CapShift will support one more
  120. language. You can also translate the documentation files and send them to me
  121. for inclusion in the distribution of CapShift.
  122.  
  123.  
  124.                          --------------------------
  125.                          2. Configuration and usage
  126.                          --------------------------
  127.  
  128.   To start CapShift simply double-click on its icon or type 'run CapShift' from
  129. a CLI. To have it activated on every boot, place it in your SYS:WBStartup
  130. drawer with the 'DONOTWAIT' tooltype, or insert 'run CapShift' in your
  131. S:user-startup file.
  132.   CapShift recognizes the following ToolTypes or CLI arguments:
  133.  
  134.           CX_PRIORITY=<pri>     : The priority of CapShift in the commodities
  135.                                   network: CapShift should be the highest
  136.                                   priority commodity installed in your system,
  137.                                   so it can kill the capslock key before any
  138.                                   other program can see it. However if you have
  139.                                   some commodity needing the capslock key as a
  140.                                   qualifier, give it a higher priority than
  141.                                   CapShift.
  142.                                   Default value = 20. Range = -128 to 127
  143.  
  144.           HOTKEY=<desc>         : By this hotkey combination you can activate
  145.                                   and deactivate 'capslock killing' and
  146.                                   'capital-toggle'. Note that this is
  147.                                   different from activating and deactivating
  148.                                   CapShift from the Commodities Exchange
  149.                                   program (see below).
  150.                                   Default value = control alt -capslock c
  151.  
  152.           KILLHIGHCAPS          : This turns the 'capslock killing' feature on
  153.                                   when 'highmap' keys are pressed.
  154.  
  155.           KILLQUALCAPS          : This turns the 'capslock killing' feature on
  156.                                   when one ore more of the 'control', 'alt' or
  157.                                   'amiga' qualifier is pressed and with the
  158.                                   keypad's keys.
  159.  
  160.           BREAK_WARN            : When CapShift terminates because of a
  161.                                   ^C signal, it displays a requester
  162.                                   informing you of the event only if BREAK_WARN
  163.                                   is set.
  164.  
  165.    Once CapShift is active you can use the Commodities Exchange program to
  166. control its activities. Note that if you disable CapShift via the Exchange
  167. program you can re-enable it only with the same method. The same applies to the
  168. hotkey combination. Besides, when you use the hotkey, CapShift simply doesn't
  169. modify the capslock state anymore, but the commodity is still active and so
  170. continues to steal the hotkey combination from the input stream.
  171.  
  172.  
  173.                            -----------------------
  174.                            3. Terminating CapShift
  175.                            -----------------------
  176.  
  177. As a commodity, CapShift can be terminated in three ways:
  178.  
  179.   a) Run CapShift a second time.
  180.  
  181.   b) Use the Commodities Exchange program.
  182.  
  183.   c) Send CapShift a 'control-C' signal:
  184.  
  185.     c.1) If you started CapShift from workbench (or WBStartup drawer) use a
  186.          task control utility such as TaskX by Steve Tibbet.
  187.  
  188.     c.2) If you started CapShift from a CLI (or user-startup) do the following:
  189.  
  190.           1) Open a CLI
  191.           2) Issue the 'STATUS' command and note the process number of CapShift
  192.           3) Issue 'BREAK <n> C' where <n> is the process number noted above
  193.  
  194.  
  195.                          ----------------------------
  196.                          4. Criticism and suggestions
  197.                          ----------------------------
  198.  
  199.    I hope you will find CapShift useful, and if you have any criticism,
  200. suggestions, bug report, ideas for enhancements in possible future versions,
  201. you can write ( in Italian or English ) at the following address:
  202.  
  203.         Alessandro Sala
  204.         Via A. Grandi, 16
  205.         20014 Nerviano (MI)
  206.         Italy
  207.  
  208.     If you have E-Mail capability you can also contact me at the following
  209. Internet address (at least until the end of January 1994):
  210.  
  211.         tser1506@cdc835.cdc.polimi.it
  212.  
  213.  
  214.                                                   Thank you
  215.  
  216. **********************************************************************************
  217.                                     History
  218. **********************************************************************************
  219.  
  220.  
  221.  
  222. ------------
  223. Version 1.00
  224. ------------
  225.  
  226.      First release.
  227.